Fireblocks Embedded Wallet SDK Documentation/com.fireblocks.sdk.ew.models

Package-level declarations

Types

data class Account(val accountId: Int? = null, val walletId: String? = null)

data class AddressDetails(val accountName: String? = null, val accountId: String? = null, val asset: String? = null, val address: String? = null, val addressType: AddressDetails.AddressType? = null, val addressDescription: String? = null, val tag: String? = null, val addressIndex: Int? = null, val change: Int? = null, val coinType: Int? = null, val customerRefId: String? = null, val addressFormat: String? = null, val legacyAddress: String? = null, val paymentAddress: String? = null, val userDefined: Boolean? = null, val state: State? = null)

Created by Fireblocks Ltd. on 08/08/2023.

AddressType

enum AddressType : Enum<AddressType> , UnknownEnum

Created by Fireblocks Ltd. on 07/10/2024.

AmlRegistrationResult

data class AmlRegistrationResult(val provider: String? = null, val success: Boolean? = null, val timestamp: Long? = null)

Created by Fireblocks Ltd. on 07/10/2024.

AmlScreeningResult

data class AmlScreeningResult(val provider: String? = null, val payload: Any? = null)

Created by Fireblocks Ltd. on 07/10/2024.

AmountInfo

data class AmountInfo(val amount: String? = null, val requestedAmount: String? = null, val netAmount: String? = null, val amountUSD: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

Asset

data class Asset(val id: String? = null, val symbol: String? = null, val name: String? = null, val decimals: Int? = null, val networkProtocol: String? = null, val testnet: Boolean? = null, val hasFee: Boolean? = null, val type: String? = null, val baseAsset: String? = null, val ethNetwork: String? = null, val echContractAddress: String? = null, val issuerAddress: String? = null, val blockchainSymbol: String? = null, val deprecated: Boolean? = null, val coinType: Int? = null, val blockchain: String? = null, val blockchainDisplayName: String? = null, val algorithm: Algorithm? = null)

Created by Fireblocks Ltd. on 7/10/2024

AssetBalance

data class AssetBalance(val id: String? = null, val total: String? = null, val available: String? = null, val pending: String? = null, val frozen: String? = null, val lockedAmount: String? = null, val blockHeight: String? = null, val blockHash: String? = null, val rewardInfo: BalanceRewardInfo? = null)

Created by Fireblocks Ltd. on 08/08/2023.

AssignResponse

data class AssignResponse(val walletId: String? = null, val enabled: Boolean? = null)

Created by Fireblocks Ltd. on 28/07/2024.

AuthorizationGroups

data class AuthorizationGroups(val th: Long? = null, val users: Map<String, AuthorizationGroups.Users>? = null)

Created by Fireblocks Ltd. on 07/10/2024.

AuthorizationInfo

data class AuthorizationInfo(val allowOperatorAsAuthorizer: Boolean? = null, val logic: AuthorizationInfo.Logic? = null, val groups: List<AuthorizationGroups>? = null)

Created by Fireblocks Ltd. on 07/10/2024.

BalanceRewardInfo

data class BalanceRewardInfo(val pendingRewards: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

BlockchainDescriptor

enum BlockchainDescriptor : Enum<BlockchainDescriptor> , UnknownEnum

Values: ETH,ETH_TEST3,ETH_TEST5,ETH_TEST6,POLYGON,POLYGON_TEST_MUMBAI,AMOY_POLYGON_TEST,XTZ,XTZ_TEST,BASECHAIN_ETH,BASECHAIN_ETH_TEST3,BASECHAIN_ETH_TEST5,ETHERLINK,ETHERLINK_TEST,MANTLE,MANTLE_TEST,GUN_GUNZILLA_TEST,ETH_SONEIUM,SONEIUM_MINATO_TEST,IOTX_IOTEX

BlockInfo

data class BlockInfo(val blockHeight: String? = null, val blockHash: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

ComplianceResult

data class ComplianceResult(val aml: List<ComplianceScreeningResult>? = null, val tr: List<ComplianceScreeningResult>? = null, val amlList: List<ComplianceScreeningResult>? = null, val status: ComplianceResult.Status? = null, val amlRegistration: List<AmlRegistrationResult>? = null)

Created by Fireblocks Ltd. on 07/10/2024.

ComplianceScreeningResult

data class ComplianceScreeningResult(val provider: String? = null, val payload: Any? = null, val bypassReason: String? = null, val screeningStatus: ComplianceScreeningResult.ScreeningStatus? = null, val timestamp: Long? = null)

Created by Fireblocks Ltd. on 07/10/2024.

CreateTransactionResponse

data class CreateTransactionResponse(val id: String? = null, val status: Status? = null, val systemMessages: SystemMessageInfo? = null)

Created by Fireblocks Ltd. on 07/10/2024.

CreateWeb3ConnectionResponse

data class CreateWeb3ConnectionResponse(val id: String? = null, val sessionMetadata: Web3ConnectionSessionMetadata? = null)

DestinationTransferPeerPath

data class DestinationTransferPeerPath(val type: TransferPeerPathType, val subType: TransferPeerPathSubType? = null, val id: String? = null, val name: String? = null, val walletId: String? = null, val oneTimeAddress: OneTimeAddress? = null)

Created by Fireblocks Ltd. on 07/10/2024.

DestinationTransferPeerPathResponse

data class DestinationTransferPeerPathResponse(val type: TransferPeerPathType, val subType: String? = null, val id: String? = null, val name: String? = null, val walletId: String? = null, val tradingAccount: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

DestType

enum DestType : Enum<DestType>

Created by Fireblocks Ltd. on 07/10/2024.

Device

data class Device(val deviceId: String? = null, val enabled: Boolean? = null, val physicalDeviceId: String? = null)

EstimatedTransactionFeeResponse

data class EstimatedTransactionFeeResponse(val low: TransactionFee? = null, val medium: TransactionFee? = null, val high: TransactionFee? = null)

Created by Fireblocks Ltd. on 07/10/2024.

FeeInfo

data class FeeInfo(val networkFee: String? = null, val serviceFee: String? = null, val gasPrice: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

FeeLevel

enum FeeLevel : Enum<FeeLevel>

Created by Fireblocks Ltd. on 07/10/2024.

GetOwnershipTokensSort

enum GetOwnershipTokensSort : Enum<GetOwnershipTokensSort>

GetTransactionOperation

enum GetTransactionOperation : Enum<GetTransactionOperation> , UnknownEnum

Created by Fireblocks Ltd. on 07/10/2024.

Input

data class Input(val txHash: String? = null, val index: Int? = null)

Created by Fireblocks Ltd. on 11/11/2024.

InputsSelection

data class InputsSelection(val inputsToSpend: List<Input>? = null, val inputsToExclude: List<Input>? = null)

Created by Fireblocks Ltd. on 12/11/2024. For UTXO based blockchains, selections of inputs for the transaction.

LatestBackupKey

data class LatestBackupKey(val deviceId: String? = null, val keyId: String? = null, val publicKey: String? = null, val algorithm: Algorithm? = null)

Created by Fireblocks Ltd. on 07/10/2024.

LatestBackupResponse

data class LatestBackupResponse(val passphraseId: String? = null, val createdAt: Long? = null, val keys: List<LatestBackupKey>? = null)

Created by Fireblocks Ltd. on 07/10/2024.

ListOwnedTokensSort

enum ListOwnedTokensSort : Enum<ListOwnedTokensSort>

MediaEntityResponse

data class MediaEntityResponse(val url: String? = null, val contentType: MediaEntityResponse.ContentType? = null)

NetworkRecord

data class NetworkRecord(val source: SourceTransferPeerPathResponse? = null, val destination: DestinationTransferPeerPathResponse? = null, val txHash: String? = null, val networkFee: String? = null, val assetId: String? = null, val netAmount: String? = null, val isDropped: Boolean? = null, val type: String? = null, val destinationAddress: String? = null, val sourceAddress: String? = null, val amountUSD: String? = null, val index: Int? = null, val rewardInfo: RewardInfo? = null)

Created by Fireblocks Ltd. on 07/10/2024.

NodeControls

data class NodeControls(val type: String? = null, val tag: String? = null)

Created by Fireblocks Ltd. on 12/11/2024. Configure special node requirements. For routing transactions to a custom node please set the type to NODE_ROUTER and the tag to the pre-configured tag value. For MEV protection, set only the type property to MEV (tag is not required at this stage)

OneTimeAddress

data class OneTimeAddress(val address: String, val tag: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

Order

enum Order : Enum<Order>

OrderBy

enum OrderBy : Enum<OrderBy>

PaginatedResponse

data class PaginatedResponse<T>(val data: List<T>? = null, val paging: Paging? = null)

Paging

data class Paging(val next: String? = null)

PayloadBody

data class PayloadBody(val payload: String)

Created by Fireblocks Ltd. on 29/07/2024.

PreHash

data class PreHash(val content: String, val hashAlgorithm: String)

Created by Fireblocks Ltd. on 11/11/2024.

RawMessageData

data class RawMessageData(val messages: List<UnsignedRawMessage>, val algorithm: Algorithm? = null)

Created by Fireblocks Ltd. on 11/11/2024.

RespondToConnectionRequest

data class RespondToConnectionRequest(val approve: Boolean)

RewardInfo

data class RewardInfo(val srcRewards: String? = null, val destRewards: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

SignedMessage

data class SignedMessage(val content: String? = null, val algorithm: Algorithm? = null, val derivationPath: List<Long>? = null, val signature: SignedMessageSignature? = null, val publicKey: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

SignedMessageSignature

data class SignedMessageSignature(val fullSig: String? = null, val r: String? = null, val s: String? = null, val v: Int? = null)

Created by Fireblocks Ltd. on 07/10/2024.

SourceTransferPeerPath

data class SourceTransferPeerPath(val subType: TransferPeerPathSubType? = null, val id: String? = null, val name: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

SourceTransferPeerPathResponse

data class SourceTransferPeerPathResponse(val type: TransferPeerPathType, val subType: String? = null, val id: String? = null, val name: String? = null, val walletId: String? = null, val tradingAccount: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

SourceType

enum SourceType : Enum<SourceType>

Created by Fireblocks Ltd. on 07/10/2024.

SpamOwnershipResponse

data class SpamOwnershipResponse(val result: Boolean? = null, val source: SpamOwnershipResponse.SpamOwnershipResponseSource? = null)

SpamTokenResponse

data class SpamTokenResponse(val result: Boolean)

State

enum State : Enum<State> , UnknownEnum

Status

enum Status : Enum<Status> , UnknownEnum

Created by Fireblocks Ltd. on 07/10/2024.

SuccessResponse

data class SuccessResponse(val success: Boolean? = null)

SystemMessageInfo

data class SystemMessageInfo(val type: SystemMessageInfo.Type? = null, val message: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

TokenCollectionResponse

data class TokenCollectionResponse(val id: String? = null, val name: String? = null, val symbol: String? = null)

TokenOwnershipResponse

data class TokenOwnershipResponse(val id: String? = null, val tokenId: String? = null, val standard: String? = null, val balance: String? = null, val ownershipStartTime: Long? = null, val ownershipLastUpdateTime: Long? = null, val blockchainDescriptor: BlockchainDescriptor? = null, val status: TokensStatus? = null, val metadataURI: String? = null, val cachedMetadataURI: String? = null, val media: List<MediaEntityResponse>? = null, val spam: SpamOwnershipResponse? = null, val collection: TokenCollectionResponse? = null, val vaultAccountId: String? = null, val description: String? = null, val name: String? = null, val ncwId: String? = null, val ncwAccountId: String? = null)

TokenResponse

data class TokenResponse(val id: String? = null, val tokenId: String? = null, val standard: String? = null, val blockchainDescriptor: BlockchainDescriptor? = null, val metadataURI: String? = null, val cachedMetadataURI: String? = null, val media: List<MediaEntityResponse>? = null, val spam: SpamTokenResponse? = null, val collection: TokenCollectionResponse? = null, val description: String? = null, val name: String? = null)

TokensSpam

enum TokensSpam : Enum<TokensSpam>

TokensStatus

enum TokensStatus : Enum<TokensStatus> , UnknownEnum

TransactionFee

data class TransactionFee(val gasLimit: String? = null, val feePerByte: String? = null, val gasPrice: String? = null, val networkFee: String? = null, val baseFee: String? = null, val priorityFee: String? = null, val maxFeePerGasDelta: String? = null, val l1Fee: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

TransactionOperation

enum TransactionOperation : Enum<TransactionOperation>

Created by Fireblocks Ltd. on 07/10/2024.

TransactionRequest

data class TransactionRequest(val operation: TransactionOperation? = null, val note: String? = null, val externalTxId: String? = null, val assetId: String? = null, val source: SourceTransferPeerPath? = null, val destination: DestinationTransferPeerPath? = null, val destinations: List<TransactionRequestDestination>? = null, val amount: String? = null, val treatAsGrossAmount: Boolean? = null, val forceSweep: Boolean? = null, val feeLevel: FeeLevel? = null, val fee: String? = null, val priorityFee: String? = null, val failOnLowFee: Boolean? = null, val maxFee: String? = null, val maxTotalFee: String? = null, val gasLimit: String? = null, val gasPrice: String? = null, val networkFee: String? = null, val replaceTxByHash: String? = null, val extraParameters: Any? = null, val customerRefId: String? = null, val travelRuleMessage: TravelRuleCreateTransactionRequest? = null, val useGasless: Boolean? = null)

Created by Fireblocks Ltd. on 07/10/2024.

TransactionRequestDestination

data class TransactionRequestDestination(val amount: String? = null, val destination: DestinationTransferPeerPath? = null)

Created by Fireblocks Ltd. on 07/10/2024.

TransactionResponse

data class TransactionResponse(val id: String? = null, val externalTxId: String? = null, val status: Status? = null, val subStatus: String? = null, val txHash: String? = null, val operation: GetTransactionOperation? = null, val note: String? = null, val assetId: String? = null, val source: SourceTransferPeerPathResponse? = null, val sourceAddress: String? = null, val destination: DestinationTransferPeerPathResponse? = null, val destinations: List<TransactionResponseDestination>? = null, val destinationAddress: String? = null, val destinationAddressDescription: String? = null, val destinationTag: String? = null, val contractCallDecodedData: TransactionResponseContractCallDecodedData? = null, val amountInfo: AmountInfo? = null, val treatAsGrossAmount: Boolean? = null, val feeInfo: FeeInfo? = null, val feeCurrency: String? = null, val networkRecords: List<NetworkRecord>? = null, val createdAt: Long? = null, val lastUpdated: Long? = null, val createdBy: String? = null, val signedBy: List<String>? = null, val rejectedBy: String? = null, val authorizationInfo: AuthorizationInfo? = null, val exchangeTxId: String? = null, val customerRefId: String? = null, val amlScreeningResult: AmlScreeningResult? = null, val complianceResult: ComplianceResult? = null, val extraParameters: Any? = null, val signedMessages: List<SignedMessage>? = null, val numOfConfirmations: Int? = null, val blockInfo: BlockInfo? = null, val index: Int? = null, val rewardInfo: RewardInfo? = null, val systemMessages: SystemMessageInfo? = null, val addressType: AddressType? = null, val errorDescription: String? = null)

Created by Fireblocks Ltd. on 07/10/2024. Transaction response

TransactionResponseContractCallDecodedData

data class TransactionResponseContractCallDecodedData(val contractName: String? = null, val functionCalls: List<Any>? = null)

Created by Fireblocks Ltd. on 07/10/2024.

TransactionResponseDestination

data class TransactionResponseDestination(val destinationAddress: String? = null, val destinationAddressDescription: String? = null, val amount: String? = null, val amountUSD: String? = null, val amlScreeningResult: AmlScreeningResult? = null, val destination: DestinationTransferPeerPathResponse? = null, val authorizationInfo: AuthorizationInfo? = null)

Created by Fireblocks Ltd. on 07/10/2024.

TransferPeerPathSubType

enum TransferPeerPathSubType : Enum<TransferPeerPathSubType>

Created by Fireblocks Ltd. on 07/10/2024.

TransferPeerPathType

enum TransferPeerPathType : Enum<TransferPeerPathType> , UnknownEnum

Created by Fireblocks Ltd. on 07/10/2024.

TravelRuleCreateTransactionRequest

data class TravelRuleCreateTransactionRequest(val originator: TravelRulePiiIVMS, val beneficiary: TravelRulePiiIVMS, val originatorVASPdid: String? = null, val beneficiaryVASPdid: String? = null, val beneficiaryVASPname: String? = null, val transactionBlockchainInfo: TravelRuleTransactionBlockchainInfo? = null, val encrypted: String? = null, val protocol: String? = null, val skipBeneficiaryDataValidation: Boolean? = null, val travelRuleBehavior: Boolean? = null, val originatorProof: TravelRuleOwnershipProof? = null, val beneficiaryProof: TravelRuleOwnershipProof? = null, val pii: TravelRulePiiIVMS? = null)

Created by Fireblocks Ltd. on 07/10/2024.

TravelRuleOwnershipProof

data class TravelRuleOwnershipProof(val type: String? = null, val proof: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

TravelRulePiiIVMS

data class TravelRulePiiIVMS(val fullName: String? = null, val dateOfBirth: String? = null, val placeOfBirth: String? = null, val address: String? = null, val identificationNumber: String? = null, val nationality: String? = null, val countryOfResidence: String? = null, val taxIdentificationNumber: String? = null, val customerNumber: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

TravelRuleTransactionBlockchainInfo

data class TravelRuleTransactionBlockchainInfo(val txHash: String? = null, val origin: String? = null, val destination: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.

UnsignedRawMessage

data class UnsignedRawMessage(val content: String, val bip44AddressIndex: Int? = null, val bip44change: Int? = null, val derivationPath: List<Long>? = null, val type: String? = null, val preHash: PreHash? = null)

The bip44AddressIndex and bip44change fields complement the derivation path given the source id and asset were provided in the transaction body request. In case none of the above was provided, please specify the derivation path.

Web3Connection

data class Web3Connection(val id: String? = null, val userId: String? = null, val sessionMetadata: Web3ConnectionSessionMetadata? = null, val feeLevel: Web3ConnectionFeeLevel? = null, val chainIds: List<String>? = null, val connectionType: Web3ConnectionType? = null, val connectionMethod: Web3ConnectionMethod? = null, val creationDate: String? = null) : Serializable

Requested dApp connection's data

Web3ConnectionFeeLevel

enum Web3ConnectionFeeLevel : Enum<Web3ConnectionFeeLevel>

Web3ConnectionMethod

enum Web3ConnectionMethod : Enum<Web3ConnectionMethod> , UnknownEnum

The method through which the connection was established

Web3ConnectionRequest

data class Web3ConnectionRequest(val feeLevel: Web3ConnectionFeeLevel, val uri: String, val ncwAccountId: Int, val chainIds: List<String>? = null)

Web3ConnectionSessionMetadata

data class Web3ConnectionSessionMetadata(val appUrl: String? = null, val appName: String? = null, val appDescription: String? = null, val appIcon: String? = null)

Web3ConnectionSort

enum Web3ConnectionSort : Enum<Web3ConnectionSort>

Web3ConnectionType

enum Web3ConnectionType : Enum<Web3ConnectionType> , UnknownEnum

The connection's type

Web3Filter

data class Web3Filter(val id: String? = null, val userId: String? = null, val connectionMethod: Web3ConnectionMethod? = null, val feeLevel: Web3ConnectionFeeLevel? = null, val appUrl: String? = null, val appName: String? = null)

Created by Fireblocks Ltd. on 07/10/2024.